MPIOptions

class MPIOptions

This class holds the options

Constructors

Link copied to clipboard
fun MPIOptions()

Types

Link copied to clipboard
interface AbstractFlatLabel

AbstractFlatLabel holds the properties of flat labels of data classes: FlatLabelInternal and FlatLabel

Link copied to clipboard
interface AbstractFlatLabelAllLocations

AbstractFlatLabelAllLocations holds the properties of flat label all locations of data classes: FlatLabelAllLocationsInternal and FlatLabelAllLocations

Link copied to clipboard
data class AddFlatLabel(val appearance: MPIOptions.FlatLabelAppearance? = null)
Link copied to clipboard
data class AddFloatingLabel(    val scale: Double? = null,     val ranks: Double? = null,     val appearance: MPIOptions.FloatingLabelAppearance? = null)
Link copied to clipboard
data class BlueDot(    val allowImplicitFloorLevel: Boolean? = null,     val smoothing: Boolean? = null,     val showBearing: Boolean? = null,     val baseColor: String? = null)

BlueDot holds the properties of values to be set when enabling blue dot

Link copied to clipboard
enum CAMERA_DIRECTION : Enum<MPIOptions.CAMERA_DIRECTION>
Link copied to clipboard
object CAMERA_DIRECTION_SERIALIZER

serializer for camera direction

Link copied to clipboard
data class CameraAnimation(val duration: Double? = null, val easing: MPIOptions.EASING_MODE? = null)
Link copied to clipboard
data class CameraPadding(    val top: Double,     val bottom: Double,     val left: Double,     val right: Double)

Focus padding for focus

Link copied to clipboard
data class CameraTargets(    val nodes: List<MPINavigatable.MPINode>? = null,     val polygons: List<MPINavigatable.MPIPolygon>? = null,     val coordinates: List<MPIMap.MPICoordinate>? = null)
Link copied to clipboard
data class CameraTransformCoordinate(    val zoom: Double? = null,     val tilt: Double? = null,     val rotation: Double? = null,     val position: MPIMap.MPICoordinate? = null)
Link copied to clipboard
data class CameraTransformNode(    val zoom: Double? = null,     val tilt: Double? = null,     val rotation: Double? = null,     val position: MPINavigatable.MPINode? = null)
Link copied to clipboard
data class ConnectionPath @JvmOverloads constructor(    val drawDuration: Double? = null,     val nearRadius: Double? = null,     val farRadius: Double? = null,     val color: String? = null)

Connection path object

Link copied to clipboard
enum EASING_MODE : Enum<MPIOptions.EASING_MODE>
Link copied to clipboard
object EASING_MODE_SERIALIZER

serializer for easing mode

Link copied to clipboard
data class FlatLabel(val text: String? = null, val appearance: MPIOptions.FlatLabelAppearance? = null) : MPIOptions.AbstractFlatLabel

FlatLabel holds the properties of flat labels to be set when setting flat label to polygons

Link copied to clipboard
data class FlatLabelAllLocations(val appearance: MPIOptions.FlatLabelAppearance? = null, val locations: List<String>? = null) : MPIOptions.AbstractFlatLabelAllLocations

FlatLabelAllLocations holds the properties of flat labels to be set when setting flat labels to a collection of polygons

Link copied to clipboard
data class FlatLabelAllLocationsInternal(    var legacyLabels: Boolean,     val appearance: MPIOptions.FlatLabelAppearance? = null,     val locations: List<String>? = null) : MPIOptions.AbstractFlatLabelAllLocations

FlatLabelAllLocationsInternal exposes the flat labels flag to be true internally while setting flat labels to a collection of polygons

Link copied to clipboard
data class FlatLabelAppearance @JvmOverloads constructor(    val height: Float? = null,     val margin: Float? = null,     val color: String? = null,     val fontSize: Float? = null,     val scaleMin: Float? = null,     var scaleStep: Float? = null)

FlatLabelAppearance holds the appearance properties of flat labels to be set when labeling polygons

Link copied to clipboard
data class FlatLabelInternal(    var flatLabels: Boolean,     val text: String? = null,     val appearance: MPIOptions.FlatLabelAppearance? = null) : MPIOptions.AbstractFlatLabel

FlatLabelInternal exposes the flat labels flag to be true internally while setting flat labels to polygons

Link copied to clipboard
data class FloatingLabel @JvmOverloads constructor(    val text: String,     val shortText: String? = null,     val stateText: String? = null,     val rank: Double? = null,     val appearance: MPIOptions.FloatingLabelAppearance? = null)

FloatingLabel holds the properties of floating labels to be set when setting labels to polygons

Link copied to clipboard
data class FloatingLabelAllLocations @JvmOverloads constructor(val appearance: MPIOptions.FloatingLabelAppearance? = null, val locations: List<String>? = null)

FloatingLabelAllLocations holds the properties of floating labels to be set at a collection of locations

Link copied to clipboard
data class FloatingLabelAppearance @JvmOverloads constructor(    val margin: Double? = null,     val text: MPIOptions.FloatingLabelAppearance.Text? = null,     val marker: MPIOptions.FloatingLabelAppearance.Marker? = null)

FloatingLabelAppearance holds the appearance properties of floating labels to be set when labeling polygons

Link copied to clipboard
data class FocusOn(    val changeZoom: Boolean? = null,     val minZoom: Double? = null,     val rotation: Double? = null,     val tilt: Double? = null,     val padding: MPIOptions.CameraPadding? = null,     val duration: Double? = null,     val easing: MPIOptions.EASING_MODE? = null)
Link copied to clipboard
data class GetPolygonsAtCoordinate(val includeNonInteractive: Boolean? = false)
Link copied to clipboard
data class Init @JvmOverloads constructor(    val clientId: String = "",     val clientSecret: String = "",     val venue: String = "",     val perspective: String? = "Website",     val baseUrl: String = "",     val noAuth: Boolean = false,     val firstMapId: String? = null,     val headers: List<MPIHeader>? = null,     val useBundle: Boolean? = false,     val emitAnalyticsEvents: Boolean? = true)

This class hold the properties of values to be used when initialzing a map

Link copied to clipboard
data class Journey @JvmOverloads constructor(    val connectionTemplateString: String? = null,     val destinationMarkerTemplateString: String? = null,     val departureMarkerTemplateString: String? = null,     val pathOptions: MPIOptions.Path? = null,     val polygonHighlightColor: String? = null)

Journey holds the properties of journey when drawing jouney

Link copied to clipboard
data class Marker(val rank: Double? = null, val anchor: MPIOptions.MARKER_ANCHOR? = null)

Marker holds the properties of values when adding markers containing arbitrary HTML

Link copied to clipboard
enum MARKER_ANCHOR : Enum<MPIOptions.MARKER_ANCHOR>

MARKER_ANCHOR holds the properties of anchor when adding markers

Link copied to clipboard
object MARKER_ANCHOR_SERIALIZER

serializer for marker anchor

Link copied to clipboard
data class Path @JvmOverloads constructor(    val color: String? = null,     var pulseColor: String? = null,     var nearRadius: Double? = null,     var farRadius: Double? = null,     var drawDuration: Double? = null,     var drawConnectionSegments: Boolean? = null,     var pulseIterations: Double? = null,     var connectionPathOptions: MPIOptions.ConnectionPath? = null,     var displayArrowsOnPath: Boolean? = null)

Path holds the properties of values to be set when path is drawn

Link copied to clipboard
data class ShowVenue(    val firstMapId: String? = null,     val labelAllLocationsOnInit: Boolean = true,     val backgroundColor: String? = null,     val backgroundAlpha: Double? = null)

ShowVenue holds the properties of values to be set when showing a venue.

Functions

Link copied to clipboard
open override fun toString(): String

convert Marker to string